OLBinaryNegate Class Reference

A binary function object that negates the action of another binary function object. More...

#import <ObjectiveLib/Functional.h>

Inheritance diagram for OLBinaryNegate:

List of all members.

Public Member Functions
(void)	- encodeWithCoder:
	Encode the function object.
(BOOL)	- performBinaryFunctionWithArg:andArg:
	Perform the underlying function and return the opposite of its result.
(void)	- writeSelfToStream:
Initializers and Deallocators
(id)	- initWithCoder:
(id)	- initWithBinaryFunction:
	Initialize the function object with the function that should be negated.
(id)	- initWithObjectInStream:
(void)	- dealloc
	Finalize the function object and deallocate any allocated memory.
Static Public Member Functions
(id)	+ functorWithBinaryFunction:
	Create and return an instance of OLBinaryNegate.
Protected Attributes
OLStreamableFunctor < OLBoolBinaryFunction > *	fn
	The function object to be negated.

---

Detailed Description

A binary function object that negates the action of another binary function object.

The action message of this object simple returns the opposite of the target function object.

---

Member Function Documentation

- (void) dealloc

Finalize the function object and deallocate any allocated memory.

- (void) encodeWithCoder:

(NSCoder *)

encoder

Encode the function object.

The function object is saved to an archive using encoder. The function object will be retrieved from the archive using the initializer #initWithCoder:.

Parameters:

encoder

the coder which will save the function object to the archive

Reimplemented from OLStreamableFunctor.

+ (id) functorWithBinaryFunction:

(OLStreamableFunctor< OLBoolBinaryFunction > *)

function

Create and return an instance of OLBinaryNegate.

The opposite value of the given function will be returned when this object's performBinaryFunctionWithArg:andArg: is called.

Note:

If OpenStep is present the returned object will be autoreleased before being returned.

Parameters:

function

the function that OLBinaryNegate will negate

Returns:

a new functor

- (id) initWithBinaryFunction:

(OLStreamableFunctor< OLBoolBinaryFunction > *)

function

Initialize the function object with the function that should be negated.

Parameters:

function

the target function that will be negated

Returns:

a reference to this function object

- (BOOL) performBinaryFunctionWithArg:		(id)	arg1
andArg:		(id)	arg2

Perform the underlying function and return the opposite of its result.

Parameters:

arg1	the first argument to pass to the target function
arg2	the second argument to pass to the target function

Returns:

the opposite of the target function's result

Reimplemented from <OLBoolBinaryFunction>.

---

Member Data Documentation

- (OLStreamableFunctor<OLBoolBinaryFunction>*) fn [protected]

The function object to be negated.

---

The documentation for this class was generated from the following file:

• Functional.h